home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_1 / bbdice12.zip / BBDICE.DOC < prev    next >
Text File  |  1992-06-18  |  18KB  |  410 lines

  1.  
  2.                              BASEBALL DICE    
  3.  
  4.                                   v1.2
  5.  
  6.                                    by
  7.  
  8.                               Al Lawrence
  9.  
  10.                             Sunrise-80  BBS
  11.                             (404) 256-9525
  12.  
  13.  
  14.  
  15.  
  16.                                 OVERVIEW
  17.                                 ________
  18.  
  19.  
  20.    Baseball Dice plays pretty much like a regular game of baseball, with the 
  21.    exception that you use dice to "hit" the ball and we do not count the balls
  22.    and strikes (ie: 1 strike = a strikeout AND 1 ball = a walk).
  23.  
  24.    The object of the game is to beat the game score that you, the Sysop, have 
  25.    already posted. Once you have beaten the score, you may choose to quit the
  26.    game or you can play through the entire 9 innnings. NOTE: Ties lose!
  27.  
  28.  
  29.    NOTE: Most errors will be logged to a file called DFRAME.ERR which is
  30.          created in the directory you run the door from.
  31.  
  32.  
  33.  
  34.                               INSTALLATION
  35.                               ____________
  36.  
  37.  
  38.    Installation is fairly easy and straight-forward. The following steps and
  39.    examples should have you up and running in a very short period of time.
  40.    It is assumed that you are familiar with setting up DOORS on your system.
  41.    To this end, only examples of the configuration file and Door batch file
  42.    are described.
  43.  
  44.       1) Create a directory to hold all BBDICE files
  45.  
  46.       2) Unzip BBDICExx.ZIP into the the above directory
  47.  
  48.          NOTE: BRUN45.EXE is not included but is required !!!
  49.  
  50.       3) Create a configuration file, with a name of your choice, or
  51.          modify the supplied BBDICE.CFG file. A description follows:
  52.  
  53.             **                       Location of system file (See Below)
  54.             SUNRISE-80 BBS           Your BBS Name
  55.             Al                       Sysop's First nameAP
  56.  
  57.             Lawrence                 Sysop's Last Name
  58.  
  59. |-----------------------------------------------------------------------------|
  60. | READ!     1                        CommPort  \ These 2 lines are required   |
  61. | READ!     1                        Node #    / ONLY for GTUSER.BBS          |
  62. |-----------------------------------------------------------------------------|
  63.  
  64.             00000000                 Registration Number
  65.  
  66.     !   #   1                        Maximum # of Games per day
  67.                                      (Sysop gets 99, Registered version ONLY)
  68.  
  69.             50                       Number of Top Score entries.
  70.                                      Minimum = 10, Maximum = 99.
  71.  
  72.         #   NONE                     Drive:\Path\Filename to contain the
  73.                                      Top Score Bulletin or enter NONE
  74.                                      for NO Bulletin creation.
  75.  
  76.         #   NONE                     Drive:\Path\Filename to contain the
  77.                                      Top Score Bulletin (Color) or enter NONE
  78.                                      for NO Bulletin creation.
  79.  
  80.             2                        1 = DO NOT Display ADOPT-A-DOOR Message
  81.                                      2 = Display ADOPT-A-DOOR message
  82.  
  83.         #   2                        Keyboard timeout value in Minutes
  84.  
  85.     !   #   0                        Time allowed in Door
  86.                                      (Sysop = Time Remaining - REG. VERSION)
  87.  
  88.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  89.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  90.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  91.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  92.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  93.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  94.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  95.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  96.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  97.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  98.     @   #   XXXX/YYYY                 Blackout Range  From/To
  99.     @   #   XXXX/YYYY                 Blackout Range  From/To
  100.     @   #   XXXX/YYYY                 Blackout Range  From/To
  101.     @   #   XXXX/YYYY                 Blackout Range  From/To
  102.     @   #   XXXX/YYYY                 Blackout Range  From/To
  103.  
  104.  
  105.      
  106.               ** = Replace with ONE of the following:
  107.  
  108. C:\PCB\PCBOARD.SYS              <- For PCBoard systems using PCBOARD.SYS only
  109. C:\BBS\CALLINFO.BBS             <- For Wildcat! systems (prior to v3.0)
  110. C:\BBS\USERINFO.DAT             <- For Wildcat! systems using v3.x
  111.                                    (Note:DOOR.SYS must be in SAME directory)
  112. C:\BBS\DOOR.SYS                 <- For ANY systems that support DOOR.SYS
  113. C:\BBS\DORINFOx.DEF             <- For ANY systems that support DORINFOx.DEF
  114. C:\BBS\SFDOORS.DAT              <- For Spitfire systems.
  115. C:\BBS\CHAIN.TXT                <- For WWIV systems 
  116. C:\BBS\GTUSER.BBS               <- For GT Power 
  117.                                    * if using this option you must put the
  118.                                      ComPort # on line 5 and the Node # on
  119.                                      line 6 of the configuration file
  120.  
  121.  
  122.  
  123.  
  124.            # = Requires registration to change to a different value.
  125.            ! = See "Plays Per Day" Below
  126.            @ = See "Blackout Periods" Below
  127.  
  128.                NOTE: There are NO Blank Lines in the Config File!!
  129.  
  130.  
  131.  
  132.  
  133.       4) Create a batch file or modify the BBDICE file supplied. A
  134.          description of this file follows:
  135.  
  136.             ECHO off
  137.             cd\PCB\DOORS\BBDICE       Location of BBDICE files
  138.             BBDICE  BBDICE.CFG        EXE filename and CFG filename (Name
  139.                                       used in creating file in #3 above)
  140.             CD\PCB
  141.             BOARD
  142.  
  143.  
  144.        5) When running in more than one node, be sure to supply a
  145.           different configuration name for each node (your choice of name).
  146.  
  147.  
  148.   
  149.                           BLACKOUT PERIODS
  150.                           ________________
  151.  
  152.       Use the Blackout ranges option to define up to 5 time periods during
  153.       which you DO NOT want the Door to be played. If a caller tries to access 
  154.       the Door during the Blackout period, they will be shown a message that
  155.       contains ALL the Blackout periods you have defined, and to try the Door
  156.       at a later time.
  157.  
  158.       Each of the 5 Blackout ranges takes the form of XXXX/YYYY, where
  159.       XXXX=beginning time and YYYY=the ending time. For example, 0930/1230
  160.       means to NOT allow the Door to be played between 9:30am and 12:30pm.
  161.  
  162.       IMPORTANT: - All times must be 4 digits & must follow the XXXX/YYYY format
  163.                  - DO NOT change the XXXX/YYYY entry UNLESS you want to assign
  164.                    a Blackout range.
  165.                  - You MUST use the MILITARY time format. Example: 2030=8:30pm
  166.                    0900=9am, 0030=12:30am, 1700=5pm, etc.
  167.  
  168.  
  169.  
  170.                           PLAYS Per DAY/DOOR Time
  171.                           _______________________
  172.  
  173.       Plays Per Day and Door Time can be controlled several ways:
  174.  
  175.       (1) You can use the Games Per Day, singular option, in the config
  176.           file above. This option, will affect ALL callers whose Security
  177.           Level is NOT defined in any of the 10 optional Security Level/
  178.           Plays Per Day entries in the config file.
  179.  
  180.       (2) You can use the Door Time, singular option, in the config file
  181.           above. This option, will affect ALL callers whose Security
  182.           Level is NOT defined in any of the 10 optional Security Level/
  183.           Plays Per Day/Door Time entries in the config file.
  184.  
  185.       (3) You can restrict the number of games a specific Security Level
  186.           will be allowed to play per day or REWARD specific Levels with 
  187.           more Plays Per Day. 
  188.  
  189.           Likewise, you can restrict the Play time for a specific Security
  190.           Level or REWARD specific Levels with more Door Time.
  191.  
  192.           These options are handled by the use of the 10 config 
  193.           entries (000=00/00). 
  194.           
  195.           The format of each entry is as follows:
  196.  
  197.           XXX=YY/ZZ  where XXX is the Security Level (must be 3 digits)
  198.                      where =  is a constant and MUST be included
  199.                      where YY is the # of games per day (must be 2 digits)
  200.                      where / is a constant and MUST be included
  201.                      where ZZ is num. minutes per Door entry (must be 2 digits)
  202.           
  203.           If the callers Security Level is NOT defined, his/her Plays Per
  204.           Day and Door Time will be controlled by the values in items
  205.           (1) and (2), above, respectively..
  206.  
  207.           You may define up to 10 Security Levels. All unused entries must
  208.           be defined as   000=00/00
  209.         --------------------------------------------------------------------
  210.           Example: Suppose you had 3 Security Levels defined on your BBS as
  211.           (20=Subscriber, 30=Visiting Sysop, 40=CoSysop, 90=Friend) and you 
  212.           wanted to set Plays Per Day as :     Subscriber=5
  213.                                            Visiting Sysop=2
  214.                                                   CoSysop=3
  215.                                                    Friend=10 
  216.           
  217.           and Door Time as follows:     Subscriber=30 minutes
  218.                                     Visiting Sysop=20 minutes
  219.                                            CoSysop=10 minutes 
  220.                                             Friend=remaining call time
  221.                                
  222.  
  223.           You would set the Individual "Games per Day" config entry to 1 and 
  224.           the individual "Door Time" to 5 minutes (these would be the 
  225.           default number of games and default Time for all Security Levels
  226.           other than 20,30 or 40... make them any number you want). Next you
  227.           would replace 4 of the Security Level entries as :  020=05/30                                               
  228.                                                               030=02/20
  229.                                                               040=03/10
  230.                                                               090=10/0
  231.  
  232.  
  233.                         NON-STANDARD COM SUPPORT
  234.                         ________________________
  235.  
  236.       Support for COM 1-4 on the standard IRQ's - COM1/COM3 = IRQ4 and
  237.       COM2/COM4 = IRQ3. If you wish to use a non-standard IRQ, add the IRQ
  238.       number after the configuration filename. Let's assume your Door is
  239.       called FOOBAR and you want to use COM1 and IRQ5. The command line
  240.       passed to your Door would be:
  241.  
  242.                             FOOBAR FOOBAR.CFG /5
  243.  
  244.       The /5 tells FOOBAR to use IRQ5 rather than the standard IRQ4 that is
  245.       normally used with COM1. No /x parameter is needed for the standard
  246.       IRQ's.
  247.  
  248.       As an alternative, you may use an environmental variable on the command
  249.       line. To use the variable (following the example above), place a 
  250.       SET IRQ=5 in the batch file used to bring up your BBS (you would need a 
  251.       different IRQ number for each node). The command line would now look 
  252.       like this: 
  253.  
  254.                           FOOBAR FOOBAR.CFG /%IRQ%
  255.       
  256.       This, in combination with the use of the environmental variables 
  257.       described in the MULTI-NODE SETUP section will allow you to use one 
  258.       batch file and one config file to run this door on all nodes.
  259.  
  260.  
  261.  
  262.  
  263.                            MULTI-NODE SETUP
  264.                            ________________
  265.  
  266.       All Sunrise Doors are Multi-Node capable. Each node must have the 
  267.       ability to access a configuration file which will have its own system 
  268.       file (DORINFOx.DEF, PCBOARD.SYS, DOOR.SYS, etc) defined on the first 
  269.       line. There are 2 ways to accomplish this:
  270.  
  271.       (1) Create a separate configuration file for each node. The only 
  272.           difference between each file would be the location of the system 
  273.           file for that particular node. For example, on my system there are 2
  274.           nodes and the first line of the config files would look like this:
  275.  
  276.                         NODE1:  H:\PCB1\DOOR.SYS
  277.                         NODE2:  H:\PCB2\DOOR.SYS
  278.  
  279.           Thus, if you have a 4 node BBS, you will need 4 configuration files.
  280.  
  281.       (2) Use ONE configuration file for ALL nodes. This Door will recognize 
  282.           the following PCBoard environmental variables:
  283.  
  284.                  PCBDIR    (Directory containing the System file)
  285.                  PCBDRIVE  (Drive containing the System file)
  286.  
  287.           Thus, the first line of the SINGLE configuration file, for this Door
  288.           would look like this:
  289.  
  290.                         %PCBDRIVE%%PCBDIR%\DOOR.SYS
  291.  
  292.       NOTE: This option, as described, assumes that you are running PCBoard 
  293.             14.5a software. The environmental variables are automatically 
  294.             created by the software for each node.
  295.  
  296.             HOWEVER, if you are running other BBS software you should be able
  297.             to set the variables EXACTLY as described below, for EACH node 
  298.             (more than likely in each batch file you use to bring up EACH node):
  299.  
  300.                             PCBDRIVE=C:
  301.                             ^^^^^^^^^
  302.                             PCBDIR=\NODE2
  303.                             ^^^^^^^^
  304.             
  305.             Info with a carat (^) under it, MUST be typed as is. The rest 
  306.             depends on your naming conventions. 
  307.  
  308.             This, in combination with the use of the optional environmental
  309.             variable described in the NON-STANDARD COM SUPPORT section, will
  310.             allow you to use one batch file and one config file to run this 
  311.             door on all nodes.
  312.  
  313.  
  314.                                ADOPT-A-DOOR
  315.                                ____________
  316.  
  317.     Having been a Sysop for a number of years, I have had my share of problems
  318.     and frustrations getting financial support for my board's upkeep. A fellow
  319.     Sysop left a message on my board, not long ago, about a concept that was
  320.     being used by several boards around the country.
  321.  
  322.     The concept, ADOPT-A-DOOR, allows a caller to register (ADOPT) a door. It
  323.     would be the same as sending in a donation, only this way it is earmarked
  324.     for registering a particular door. In a way, the user feels he/she is
  325.     "getting something in return". As a Door author I have decided to build
  326.     this concept into each of my Door programs. The concept replaces the
  327.     usual message "tell the Sysop to register this Door" we find in most
  328.     doors.
  329.  
  330.     If the Door is unregisterd then a message appears on the opening screen
  331.     to that effect. After finishing or suspending a game, a message screen
  332.     is displayed about the ADOPT-A-DOOR concept. The message also tells the
  333.     caller to contact the Sysop to find out if there is any further details
  334.     to the ADOPT-A-DOOR concept. Some Sysops give extra D/L time, online
  335.     time, etc to callers that ADOPT-A-DOOR.
  336.  
  337.     If the Door has been registered, either by the Sysop or other callers,
  338.     the names of those contributors will be displayed in the closing screen.
  339.  
  340.     NOTE: If you want to display the names of the callers that contributed
  341.           to registering the Door, you must create an ASCII file called
  342.           ADOPT.SYS. You create it with an Editor or Word Processor. Enter
  343.           the name(s) of the contributors (one on each line, maximum of 5
  344.           entries, each a maximum of 30 characters long). This file must be
  345.           saved, in ASCII format, and placed in the Door directory.
  346.  
  347.  
  348.  
  349.                               LEGALITIES
  350.                               __________
  351.  
  352.  
  353.       THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS"
  354.       WITHOUT WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT
  355.       LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  356.       FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL ANYONE INVOLVED WITH
  357.       THE CREATION AND PRODUCTION OF THIS PRODUCT BE LIABLE FOR INDIRECT,
  358.       SPECIAL, OR CONSEQUENTIAL DAMAGES, ARISING OUT OF ANY USE THEREOF
  359.       OR BREACH OF ANY WARRANTY.
  360.  
  361.  
  362.  
  363.  
  364.  
  365.                              DISTRIBUTION
  366.                              ____________
  367.  
  368.    You may make this file available for downloading from your BBS or you may
  369.    upload it to any BBS of your choice, provided that you do not make any
  370.    changes to the contents of the archive (ZIP file). The archive and its
  371.    individual contents may not be used by any service that charges any money
  372.    whatsoever, without the written permission of the author.
  373.  
  374.  
  375.  
  376.  
  377.  
  378.                              REGISTRATION
  379.                              ____________
  380.  
  381.    Registration and the subsequent insertion of the registration number into
  382.    your configuation file, allows for the display of your BBS name on the
  383.    opening and closing screen as well as the reduction of a delay built into
  384.    the opening screen display along with the ability to change certain
  385.    values in the configuration file.
  386.  
  387.    To register your copy of BBDICE, please fill out the registration form
  388.    (REGISTER.FRM) and mail it along with a small donation ($20,25,etc) to
  389.    the name and address on the form.
  390.  
  391.    Be sure to use the proper upper/lower case when filling in your name and
  392.    BBS name, as they MUST match the way you entered them in the configuration
  393.    file.             ^^^^
  394.  
  395.    Based upon information supplied on the registration form, I will pre-
  396.    register you on my BBS. You will then be able to call SUNRISE-80 and pick
  397.    up your registration number.
  398.  
  399.  
  400.  
  401.                                  MISC
  402.                                  ____
  403.  
  404.    The latest version of BASEBALL DICE and other fine SUNRISE DOOR programs
  405.    are always available for download from SUNRISE-80 BBS.
  406.  
  407.    Remember, should you have any problems, questions or suggestions, be sure
  408.    to drop me a message on Sunrise-80 or in the RIME network (BBS_Doors, 
  409.    PCBHints, SYSops) or on SMARTNET (SN_Sysops) OR Fido 1:133/604
  410.